home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / Creative Computers CD-ROM, Volume 1 (Legendary Design Technologies, Inc.)(1994).iso / shareware / music / edplayer_2.1 / fr_user.doc < prev    next >
Text File  |  1994-11-17  |  39KB  |  964 lines
  1.                           kd_freq.library  3.01
  2.  
  3.                      File Requester User Documentation
  4.                      ---------------------------------
  5.  
  6.                            By:  Khalid Aldoseri
  7.                            --------------------
  8.  
  9. A File Requester is used to select a file name from the existing files on a
  10. system, or to enter a new file name.  This file requester (FR) supports all
  11. normal features in a FR plus a lot of special features as desribed below.
  12.  
  13. ------------------------------------------------------------------------------
  14.                     BASIC FILE REQUESTER OPERATION
  15. ------------------------------------------------------------------------------
  16.  
  17. The File Requester has three essential parts for its operation:  The Path
  18. gadget, the File gadget and the File List:
  19.  
  20. The Path gadget contains the path to the currently displayed directory.  You
  21. can enter any directory name there directly if you like by clicking in it and
  22. editing the text there.  The FR also changes the Path name in many cases.
  23.  
  24. The File gagdet contains the currently selected file.  You can manually edit
  25. the filename by clicking in it and editing the text.
  26.  
  27. The File List is a list of file names that covers a major portion of the FR
  28. display.  This displays the contents of the directory in the Path gadget.
  29. This contains both directories and file names.  Every time you select a new
  30. directory the File List will start displaying the contents of that directory
  31. as it reads it from the device that directory exists on.  As this is
  32. happening, the FR will tell you how many files/dirs it has found so far in the
  33. status line at the bottom of the FR.  Once the FR has finished reading the
  34. directory, it will redisplay the File List starting with directories first
  35. and files second.
  36.  
  37. Notes:
  38.  
  39. - The FR stays 'live' while reading the directory, i.e. you can abort the
  40.   directory read at any time by selecting a new directory.  You can also
  41.   scroll through the file list or resize the window and the FR will keep on
  42.   reading the directory.
  43.  
  44. - The ':' (colons) in the 'Files: nnn  Dirs: nnn' display do not appear while
  45.   the directory is being read.  When they do show up, that means that the FR
  46.   is done reading in the directory.
  47.  
  48.  
  49. The File List Display:
  50. ----------------------
  51.  
  52. The File List display contains the following information:
  53.  
  54.     test.file  *         11381  09-Dec-89  11:50    ----rwed
  55.        |       |           |        |        |         |
  56.     filename   |          size     date     time   protection
  57.               filenote                                bits
  58.                marker
  59.  
  60. If the entry is a directory, it will be displayed in a different color and it
  61. will display '-dir-' instead of the file size.  Read the 'Window Resizing'
  62. section for more details on the File List display.
  63.  
  64. The job of the File List is to allow you to select an entry from the List.  To
  65. do that, just click on an entry.  That will have one of the following effects:
  66.  
  67. a. If the entry is a file:
  68.    The FR will copy that file's name into the File gadget and move the marker
  69.    to that entry.  If the file has a file note attached to it (i.e. it has a
  70.    filenote marker) then the file's filenote is displayed in its place as long
  71.    as you hold down the mouse button.
  72.  
  73.    If you double-click on the file entry, this will select that file and
  74.    immediately 'ok' the FR and exit it.
  75.  
  76. b. If the entry is a directory:
  77.    The FR will clear the File List and start displaying the contents of the
  78.    selected directory.
  79.  
  80.  
  81. The File List can be in normal or inverted colors.  This is intended to create
  82. a visual difference for two different functions, like normal for load, and
  83. inverted for save.
  84.  
  85.  
  86. File List Modes:
  87. ----------------
  88.  
  89. The File List can also contain other information.  Clicking the right mouse
  90. button while the pointer is on the File List area will cycle through one of
  91. three modes:
  92.  
  93.   a.  Normal mode:  File List shows the selected directory.
  94.   b.  Device list:  File List shows the currently mounted devices by
  95.                     their  volume names.
  96.   c.  Assign list:  File List shows all assigns.
  97.  
  98. If you return to the Normal mode by clicking several times, then the directory
  99. displayed previously will show up immediately.  Note that if you had toggled
  100. the mode before the directory was completely read in by the FR, it will not be
  101. complete when you get back to it and the FR will re-read it.
  102.  
  103. Notes:
  104.  
  105. - The File List display is updated when the FR is done reading the directory.
  106.   However, if the user clicks on any file before that, the FR will not update
  107.   the display when it is done reading the directory.  The user has to click
  108.   on the prop gadget or move the list around and the FR will update the
  109.   display.
  110.  
  111. - If you insert a disk into a drive that has been selected in the Path
  112.   gadget the disk's directory will automatically be read and displayed.
  113.  
  114. - If the current disk is removed from the drive, the FR will clear the file
  115.   list and bring up the device name (not the old disk name) in the Path
  116.   gadget.  This means that you can take a disk out of the drive and insert
  117.   a new one and the FR will keep up with you if the current device is the
  118.   one that you are using.  This only works for devices DF0: to DF3:.
  119.  
  120.  
  121. The Path:
  122. ---------
  123.  
  124. The Path is the string contained in the Path gadget.  It shows the name of the
  125. currently selected directory.  This can be changed in many ways:
  126.  
  127. a. Direct entry:
  128.    You just click in the gadget to activate it and edit it normally.  Hit
  129.    return when you're done with editing it so that the FR will start reading
  130.    the directory you selected.  If you enter the name of an actual file into
  131.    the Path gadget, then the name will be split into its path and filename
  132.    components and handled accordingly.
  133.  
  134.    If the selected directory does not exist the FR will ask you whether you
  135.    want to create it.  Read 'Create Directory' below for details.
  136.  
  137. b. File List entry:
  138.    If you click on an entry in the File List that is a child directory of the
  139.    current Path, then that child directory is added to the Path name and that
  140.    directory is displayed.
  141.  
  142. c. Parent:
  143.    If you click on the Parent gadget (up-arrow to the right of the Path
  144.    gadget) then the parent of the current Path is displayed, if it exists.
  145.    This can be clicked several times to go up to the root directory of the
  146.    current device.  You can also use a short-cut to get the root of the device
  147.    by just clicking the _right_ mouse button on the Parent gadget.
  148.  
  149. d. Disk Icons:
  150.    These are disk icons that represent the currently mounted storage devices
  151.    in the system.  If you click on any disk icon with the left mouse button
  152.    the root directory of the selected device will be displayed.  You can
  153.    scroll through the mounted disk list via the 'Disk Scroll Up' and 'Disk
  154.    Scroll Down' arrow gadgets.  (up and down arrows at the top right of the
  155.    window).  These only work if the number of available devices is too big to
  156.    fit in the current window.
  157.  
  158.    If you click on the right mouse button over any disk icon, you will get
  159.    info about the device displayed in the file list area.  The file list is
  160.    not erased from memory, you just have to click on the prop gadget or the
  161.    up or down scroll gadgets and the file list will reappear.
  162.    Note:  If there isn't enough space to display 4 lines in the file list
  163.    area, this function will not work.
  164.  
  165. e. Reset Path Gadget: (the 'Path' text)
  166.    Clicking on the Path: text will restore the contents of both the Path and
  167.    File gadgets to what they were when the FR came up.
  168.  
  169.  
  170. Exiting the File Requester:
  171. ---------------------------
  172.  
  173. You can exit the file requester with either an 'OK', which tells the calling
  174. program that you like what you selected, i.e. the Path/File selected.  Or by
  175. a 'CANCEL' which just aborts the FR.
  176.  
  177. You can OK the FR by:
  178.  
  179.     a. Clicking on the OK gadget.
  180.     b. Double-clicking on a filename.
  181.     c. Typing a filename in the File gadget and hitting return.
  182.  
  183. You can cancel the FR by:
  184.  
  185.     a. Clicking on the Cancel gadget.
  186.     b. Hitting the 'Escape' key.
  187.     c. Closing the FR window by clicking on the close window gadget.
  188.  
  189.  
  190. The File Gadget:
  191. ----------------
  192.  
  193. This is the most